home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / pc / SPX30.ZIP / SPX_DOC.ZIP / SPX_FLC.DOC < prev    next >
Encoding:
Text File  |  1994-06-13  |  3.0 KB  |  73 lines
  1. { SPX Library Version 3.0  Copyright 1993 Scott D. Ramsay }
  2.  
  3.   SPX_FLC is the FLIC animation unit.  It allows the playing of Autodesk's
  4. .FLI, .CEL, .FLC Animator files.
  5.  
  6. ───────────────────────────────────────────────────────────────────────────
  7.   The following is SPX animation record:
  8.  
  9. type
  10.   FLC_TYPE  = record
  11.                 flcfile     : file;       { file handle }
  12.                 isok,                     { if file is running ok }
  13.                 isflc,                    { is .fli or (.flc/.cel) }
  14.                 iscel       : boolean;    { is .flc or .cel }
  15.                 speed,                    { speed in ms or jiffys }
  16.                 smark,                    { last frame tick count }
  17.                 flcf1,flcf2 : longint;    { 1st/2nd frame file offsets }
  18.                 frames,cfrm : word;       { num frames, current frame }
  19.                 x,y,w,h     : word;       { flic x,y, width /height }
  20.                 workmem     : pointer;    { work memory pointer }
  21.               end;
  22. ───────────────────────────────────────────────────────────────────────────
  23.   The following variables are user callback functions.  Set the function
  24.   to your own function to do processing during playback from the functions:
  25.     flc_play,flc_playlib
  26.  
  27.   UserPreFrame,
  28.   UserPostFrame,
  29.   UserFrameDelay : flc_proc;
  30.  
  31. ───────────────────────────────────────────────────────────────────────────
  32. function flc_open(name:string;var flc:FLC_TYPE):integer;
  33.    Opens a .FLC, Ani Pro .CEL, or .FLI file.  Returns 0 for no error
  34.    or a FLC error code.
  35.  
  36.    Check the two variables isflc/iscel to see what type of anim:
  37.  
  38.       isflc = TRUE     AniPro .FLC or .CEL file
  39.       isflc = FALSE    Animator .FLI file
  40.       iscel = TRUE     AniPro .CEL file (isflc should also be true)
  41.  
  42. ───────────────────────────────────────────────────────────────────────────
  43. function flc_frame(var flc:FLC_TYPE):integer;
  44.    Plays a single frame on an animation file. If flc_frame plays
  45.    the last frame in the animation, the next call will start at
  46.    the first frame. (usefull for looping animations)
  47.  
  48.    Returns 0 for no error or a FLC error code.
  49. ───────────────────────────────────────────────────────────────────────────
  50. procedure flc_close(var flc:FLC_TYPE);
  51.  
  52.    Closes an animation file.
  53.  
  54. ───────────────────────────────────────────────────────────────────────────
  55. function flc_play(name:string):integer;
  56.  
  57.    Quick method of playing a animation file. Plays an animation once.  Set
  58.    the variables UserPreFrame/UserPostFrame/UserFrameDelay to process
  59.    playback.
  60.  
  61.  
  62. ───────────────────────────────────────────────────────────────────────────
  63. function flc_openLib(lib:pSpxLib;name:string;var flc:FLC_TYPE):integer;
  64.  
  65.    Same as flc_open.  Opens an animation from an SPX archive file
  66.  
  67. ───────────────────────────────────────────────────────────────────────────
  68. function flc_playLib(lib:pSpxLib;name:string):integer;
  69.  
  70.    Same as flc_play. Plays an animation from an SPX archive file
  71. ───────────────────────────────────────────────────────────────────────────
  72.  
  73.